Pay-easy決済

Pay-easy決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200：正常時
  • 400：入力パラメータエラー、加盟店設定エラー
  • 500：システムエラー
  • 502：決済エラー
　　　　　　　
    ※以下のエラーコードはhttp200で返却される可能性がございます。
    　 ・E90010001
    　 ・E92000001
    　 ・E92000002
    　 ・E91099996
    　 ・E91099997

EntryTranPayEasy 取引登録

決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

Amount amount 必須 半角数字6桁
利用金額

利用可能決済金額をご確認ください。

Tax tax 半角数字6桁
税送料

利用可能決済金額をご確認ください。

URL
/payment/EntryTranPayEasy.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "amount": "1000",
  "tax": "0"
}
URL
/payment/EntryTranPayEasy.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000&Tax=0
レスポンス
正常
AccessID accessID 半角英数32桁 固定
取引ID

AccessPass accessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranPayEasy 決済実行

お客様が入力した情報で後続の決済センターと通信を行い決済を実施し、結果を返します。

リクエスト
AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

CustomerName customerName 必須 全半角40バイト
氏名

CustomerKana customerKana 必須 全半角40バイト
フリガナ

TelNo telNo 必須 半角数字記号13桁
電話番号

PaymentTermDay paymentTermDay 半角数字2桁
支払期限日数

省略時は、ショップ情報に設定された支払期限日数で処理されます。
支払期限についてをご確認ください。

PaymentExpiryDateTime paymentExpiryDateTime 半角数字12桁 固定
支払期限

yyyyMMddHHmm書式

省略時は、支払期限日数で処理されます。
支払期限についてをご確認ください。

MailAddress mailAddress 半角英数記号256桁
結果通知先メールアドレス

「Pay-easy決済依頼完了のお知らせ」メールを送信する場合は、お客様のメールアドレスを設定してください。

ShopMailAddress shopMailAddress 半角英数記号256桁
加盟店メールアドレス

お客様へ「Pay-easy決済依頼完了のお知らせ」メールを送信する際に、加盟店様にもBCCにて送信する場合メールアドレスを設定してください。
省略時は、ショップ情報に設定されたメールアドレスで処理されます。

ReceiptsDisp11 receiptsDisp11 必須 全半角42バイト
お問い合わせ先

設定可能な文字は「半角英数字 ＋ 半角記号(除く ^ ` { | } ~ & <> " ' ) ＋全角文字」です。全角文字については こちら
※お客様には表示されません
ReceiptsDisp12 receiptsDisp12 必須 半角数字記号12桁
お問い合わせ先電話番号

設定可能な文字は「半角数字と"-"(ハイフン)」です。
※お客様には表示されません
ReceiptsDisp13 receiptsDisp13 必須 半角数字記号11桁 固定
お問い合わせ先受付時間

設定可能な文字は「半角数字と"-"(ハイフン)および":"(コロン)」です。
また、「09:00-18:00」といった「2桁:2桁-2桁:2桁」書式で設定してください。
例) 09:00-18:00
※お客様には表示されません
ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

ClientFieldFlag clientFieldFlag 半角数字1桁 固定
加盟店自由項目返却フラグ

PaymentType paymentType 半角英字1桁 固定
決済タイプ

接続事業者を指定するため"E"を設定してください。

URL
/payment/ExecTranPayEasy.json
リクエストパラメータ
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "customerName": "山田太郎",
  "customerKana": "ヤマダタロウ",
  "telNo": "1234567890",
  "receiptsDisp11": "お問い合わせ先",
  "receiptsDisp12": "1234567890",
  "receiptsDisp13": "09:00-18:00",
  "paymentType": "E"
}
URL
/payment/ExecTranPayEasy.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CustomerName=山田太郎&CustomerKana=ヤマダタロウ&TelNo=1234567890&ReceiptsDisp11=お問い合わせ先&ReceiptsDisp12=1234567890&ReceiptsDisp13=09:00-18:00&PaymentType=E
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID

CustID custID 半角数字10桁
お客様番号

お客様が支払い時に使用する番号です。

BkCode bkCode 半角数字5桁
収納機関番号

お客様が支払い時に使用する番号です。

ConfNo confNo 半角数字6桁
確認番号

お客様が支払い時に使用する番号です。

EncryptReceiptNo encryptReceiptNo 半角英数記号128桁
暗号化決済番号

PaymentTerm paymentTerm 半角数字14桁 固定
支払期限日時

yyyyMMddHHmmss書式

TranDate tranDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

CheckString checkString 半角英数記号32桁
MD5ハッシュ

OrderID～TranDate＋ショップパスワードのハッシュ値を返却します。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

PaymentURL paymentURL 半角英数記号256桁
金融機関選択画面URL

金融機関選択画面に遷移するURLを返却します。テスト環境では固定の金融機関画面URLを返却しますが、本番環境では取引ごとに異なる支払い用のURLを返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "custID": "1234567890",
  "bkCode": "12345",
  "confNo": "123456",
  "encryptReceiptNo": "12345678901234556677",
  "paymentTerm": "20201225091313",
  "tranDate": "20201225091313",
  "checkString": "1e8b27418fcdc9c0214a035cd81c1749",
  "clientField1": "加盟店自由項目1",
  "clientField2": "加盟店自由項目2",
  "clientField3": "加盟店自由項目3",
  "paymentURL": "https://pay.econ.ne.jp/index?odrno\u003dxxxxxxxxxxxxx"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&CustID=1234567890&BkCode=12345&ConfNo=123456&EncryptReceiptNo=12345678901234556677&PaymentTerm=20201225091313&TranDate=20201225091313&CheckString=1e8b27418fcdc9c0214a035cd81c1749&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PaymentURL=https://pay.econ.ne.jp/index?odrno=xxxxxxxxxxxxx
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

金融機関選択画面の表示（決済実行時のPaymentTypeにE を指定した場合）

お客様をネットバンキングへ誘導する場合は、あらかじめ用意されている金融機関選択画面へと遷移させる必要があります。

決済実行時のPaymentTypeにE を指定した場合

決済実行の出力パラメータである金融機関選択画面URLへ遷移するためのページを表示してください。

なお、決済実行後、各金融機関で支払い可能となるまで20秒程度お時間がかかります。
※Pay-easy決済が集中した場合、各金融機関で支払い可能となるまで最大2時間程度お時間がかかる場合があります。
後続の金融機関の処理による影響です。ATM支払い、及び、金融機関選択画面からネットバンキングへ遷移して支払う場合が対象です。
金融機関のネットバンキングに直接ログインし、決済情報を入力して支払う場合は問題ありません。

リクエスト
PaymentURL 必須 半角英数記号256桁
金融機関選択画面URL

決済実行にて返却された文字列を指定します。 (文字列中に記号を含む)

サンプルコード
<html>
  <head>
    <meta http-equiv="refresh" content="0;URL={ PaymentURL }">
  </head>
  <body>
    遷移しない場合は下記のURLをクリックしてください。
  <br>
    <a href="{ PaymentURL }">{ PaymentURL }</a>
  </body>
</html>

PayEasyCancel 支払停止

決済センターとの通信を行い取引の支払停止処理を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

URL
/payment/PayEasyCancel.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}
URL
/payment/PayEasyCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

成功時は以下のステータスが返却されます。
CANCEL

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "CANCEL"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定したオーダーIDの取引情報を取得します。※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

4：Pay-easy決済

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=4
レスポンス
正常
Status
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
PAYSUCCESS：決済完了
EXPIRED：期限切れ
CANCEL：支払停止

ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字10桁
利用金額

Tax 半角数字10桁
税送料

SiteID 半角英数13桁
サイトID

Currency 半角英字3桁
通貨コード

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

4：Pay-easy決済

CustID 半角数字10桁
お客様番号
BkCode 半角数字5桁
収納機関番号

ConfNo 半角数字6桁
確認番号
EncryptReceiptNo 半角英数記号128桁
暗号化決済番号

PaymentTerm 半角数字14桁 固定
支払期限日時

yyyyMMddHHmmss書式

PayeasyPaymentURL 半角英数記号256桁
金融機関選択画面URL

ErrCode 半角英数3桁
エラーコード

ErrInfo 半角英数9桁
エラー詳細コード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=REQSUCCESS&ProcessDate=20201225091313&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=8&SiteID=&Currency=JPN&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=4&CustID=1234567890&BkCode=12345&ConfNo=123456&EncryptReceiptNo=12345678901234556677&PaymentTerm=20201225091313&PayeasyPaymentURL=https://example.com/receive&ErrCode=&ErrInfo=
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001